<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.lang3.text;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.util.ArrayList;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.Enumeration;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.HashMap;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.Map;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Properties;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * Substitutes variables within a string by values.<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * This class takes a piece of text and substitutes all the variables within it.<a name="line.29"></a>
<FONT color="green">030</FONT>     * The default definition of a variable is &lt;code&gt;${variableName}&lt;/code&gt;.<a name="line.30"></a>
<FONT color="green">031</FONT>     * The prefix and suffix can be changed via constructors and set methods.<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;p&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     * Variable values are typically resolved from a map, but could also be resolved<a name="line.33"></a>
<FONT color="green">034</FONT>     * from system properties, or by supplying a custom variable resolver.<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * The simplest example is to use this class to replace Java System properties. For example:<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;pre&gt;<a name="line.37"></a>
<FONT color="green">038</FONT>     * StrSubstitutor.replaceSystemProperties(<a name="line.38"></a>
<FONT color="green">039</FONT>     *      "You are running with java.version = ${java.version} and os.name = ${os.name}.");<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;/pre&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;p&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     * Typical usage of this class follows the following pattern: First an instance is created<a name="line.42"></a>
<FONT color="green">043</FONT>     * and initialized with the map that contains the values for the available variables.<a name="line.43"></a>
<FONT color="green">044</FONT>     * If a prefix and/or suffix for variables should be used other than the default ones,<a name="line.44"></a>
<FONT color="green">045</FONT>     * the appropriate settings can be performed. After that the &lt;code&gt;replace()&lt;/code&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>     * method can be called passing in the source text for interpolation. In the returned<a name="line.46"></a>
<FONT color="green">047</FONT>     * text all variable references (as long as their values are known) will be resolved.<a name="line.47"></a>
<FONT color="green">048</FONT>     * The following example demonstrates this:<a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;pre&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     * Map valuesMap = HashMap();<a name="line.50"></a>
<FONT color="green">051</FONT>     * valuesMap.put(&amp;quot;animal&amp;quot;, &amp;quot;quick brown fox&amp;quot;);<a name="line.51"></a>
<FONT color="green">052</FONT>     * valuesMap.put(&amp;quot;target&amp;quot;, &amp;quot;lazy dog&amp;quot;);<a name="line.52"></a>
<FONT color="green">053</FONT>     * String templateString = &amp;quot;The ${animal} jumped over the ${target}.&amp;quot;;<a name="line.53"></a>
<FONT color="green">054</FONT>     * StrSubstitutor sub = new StrSubstitutor(valuesMap);<a name="line.54"></a>
<FONT color="green">055</FONT>     * String resolvedString = sub.replace(templateString);<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;/pre&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     * yielding:<a name="line.57"></a>
<FONT color="green">058</FONT>     * &lt;pre&gt;<a name="line.58"></a>
<FONT color="green">059</FONT>     *      The quick brown fox jumped over the lazy dog.<a name="line.59"></a>
<FONT color="green">060</FONT>     * &lt;/pre&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     * &lt;p&gt;<a name="line.61"></a>
<FONT color="green">062</FONT>     * In addition to this usage pattern there are some static convenience methods that<a name="line.62"></a>
<FONT color="green">063</FONT>     * cover the most common use cases. These methods can be used without the need of<a name="line.63"></a>
<FONT color="green">064</FONT>     * manually creating an instance. However if multiple replace operations are to be<a name="line.64"></a>
<FONT color="green">065</FONT>     * performed, creating and reusing an instance of this class will be more efficient.<a name="line.65"></a>
<FONT color="green">066</FONT>     * &lt;p&gt;<a name="line.66"></a>
<FONT color="green">067</FONT>     * Variable replacement works in a recursive way. Thus, if a variable value contains<a name="line.67"></a>
<FONT color="green">068</FONT>     * a variable then that variable will also be replaced. Cyclic replacements are<a name="line.68"></a>
<FONT color="green">069</FONT>     * detected and will cause an exception to be thrown.<a name="line.69"></a>
<FONT color="green">070</FONT>     * &lt;p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>     * Sometimes the interpolation's result must contain a variable prefix. As an example<a name="line.71"></a>
<FONT color="green">072</FONT>     * take the following source text:<a name="line.72"></a>
<FONT color="green">073</FONT>     * &lt;pre&gt;<a name="line.73"></a>
<FONT color="green">074</FONT>     *   The variable ${${name}} must be used.<a name="line.74"></a>
<FONT color="green">075</FONT>     * &lt;/pre&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>     * Here only the variable's name referred to in the text should be replaced resulting<a name="line.76"></a>
<FONT color="green">077</FONT>     * in the text (assuming that the value of the &lt;code&gt;name&lt;/code&gt; variable is &lt;code&gt;x&lt;/code&gt;):<a name="line.77"></a>
<FONT color="green">078</FONT>     * &lt;pre&gt;<a name="line.78"></a>
<FONT color="green">079</FONT>     *   The variable ${x} must be used.<a name="line.79"></a>
<FONT color="green">080</FONT>     * &lt;/pre&gt;<a name="line.80"></a>
<FONT color="green">081</FONT>     * To achieve this effect there are two possibilities: Either set a different prefix<a name="line.81"></a>
<FONT color="green">082</FONT>     * and suffix for variables which do not conflict with the result text you want to<a name="line.82"></a>
<FONT color="green">083</FONT>     * produce. The other possibility is to use the escape character, by default '$'.<a name="line.83"></a>
<FONT color="green">084</FONT>     * If this character is placed before a variable reference, this reference is ignored<a name="line.84"></a>
<FONT color="green">085</FONT>     * and won't be replaced. For example:<a name="line.85"></a>
<FONT color="green">086</FONT>     * &lt;pre&gt;<a name="line.86"></a>
<FONT color="green">087</FONT>     *   The variable $${${name}} must be used.<a name="line.87"></a>
<FONT color="green">088</FONT>     * &lt;/pre&gt;<a name="line.88"></a>
<FONT color="green">089</FONT>     * &lt;p&gt;<a name="line.89"></a>
<FONT color="green">090</FONT>     * In some complex scenarios you might even want to perform substitution in the<a name="line.90"></a>
<FONT color="green">091</FONT>     * names of variables, for instance<a name="line.91"></a>
<FONT color="green">092</FONT>     * &lt;pre&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     * ${jre-${java.specification.version}}<a name="line.93"></a>
<FONT color="green">094</FONT>     * &lt;/pre&gt;<a name="line.94"></a>
<FONT color="green">095</FONT>     * &lt;code&gt;StrSubstitutor&lt;/code&gt; supports this recursive substitution in variable<a name="line.95"></a>
<FONT color="green">096</FONT>     * names, but it has to be enabled explicitly by setting the<a name="line.96"></a>
<FONT color="green">097</FONT>     * {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}<a name="line.97"></a>
<FONT color="green">098</FONT>     * property to &lt;b&gt;true&lt;/b&gt;.<a name="line.98"></a>
<FONT color="green">099</FONT>     *<a name="line.99"></a>
<FONT color="green">100</FONT>     * @version $Id: StrSubstitutor.java 1199894 2011-11-09 17:53:59Z ggregory $<a name="line.100"></a>
<FONT color="green">101</FONT>     * @since 2.2<a name="line.101"></a>
<FONT color="green">102</FONT>     */<a name="line.102"></a>
<FONT color="green">103</FONT>    public class StrSubstitutor {<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>        /**<a name="line.105"></a>
<FONT color="green">106</FONT>         * Constant for the default escape character.<a name="line.106"></a>
<FONT color="green">107</FONT>         */<a name="line.107"></a>
<FONT color="green">108</FONT>        public static final char DEFAULT_ESCAPE = '$';<a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * Constant for the default variable prefix.<a name="line.110"></a>
<FONT color="green">111</FONT>         */<a name="line.111"></a>
<FONT color="green">112</FONT>        public static final StrMatcher DEFAULT_PREFIX = StrMatcher.stringMatcher("${");<a name="line.112"></a>
<FONT color="green">113</FONT>        /**<a name="line.113"></a>
<FONT color="green">114</FONT>         * Constant for the default variable suffix.<a name="line.114"></a>
<FONT color="green">115</FONT>         */<a name="line.115"></a>
<FONT color="green">116</FONT>        public static final StrMatcher DEFAULT_SUFFIX = StrMatcher.stringMatcher("}");<a name="line.116"></a>
<FONT color="green">117</FONT>    <a name="line.117"></a>
<FONT color="green">118</FONT>        /**<a name="line.118"></a>
<FONT color="green">119</FONT>         * Stores the escape character.<a name="line.119"></a>
<FONT color="green">120</FONT>         */<a name="line.120"></a>
<FONT color="green">121</FONT>        private char escapeChar;<a name="line.121"></a>
<FONT color="green">122</FONT>        /**<a name="line.122"></a>
<FONT color="green">123</FONT>         * Stores the variable prefix.<a name="line.123"></a>
<FONT color="green">124</FONT>         */<a name="line.124"></a>
<FONT color="green">125</FONT>        private StrMatcher prefixMatcher;<a name="line.125"></a>
<FONT color="green">126</FONT>        /**<a name="line.126"></a>
<FONT color="green">127</FONT>         * Stores the variable suffix.<a name="line.127"></a>
<FONT color="green">128</FONT>         */<a name="line.128"></a>
<FONT color="green">129</FONT>        private StrMatcher suffixMatcher;<a name="line.129"></a>
<FONT color="green">130</FONT>        /**<a name="line.130"></a>
<FONT color="green">131</FONT>         * Variable resolution is delegated to an implementor of VariableResolver.<a name="line.131"></a>
<FONT color="green">132</FONT>         */<a name="line.132"></a>
<FONT color="green">133</FONT>        private StrLookup&lt;?&gt; variableResolver;<a name="line.133"></a>
<FONT color="green">134</FONT>        /**<a name="line.134"></a>
<FONT color="green">135</FONT>         * The flag whether substitution in variable names is enabled.<a name="line.135"></a>
<FONT color="green">136</FONT>         */<a name="line.136"></a>
<FONT color="green">137</FONT>        private boolean enableSubstitutionInVariables;<a name="line.137"></a>
<FONT color="green">138</FONT>    <a name="line.138"></a>
<FONT color="green">139</FONT>        //-----------------------------------------------------------------------<a name="line.139"></a>
<FONT color="green">140</FONT>        /**<a name="line.140"></a>
<FONT color="green">141</FONT>         * Replaces all the occurrences of variables in the given source object with<a name="line.141"></a>
<FONT color="green">142</FONT>         * their matching values from the map.<a name="line.142"></a>
<FONT color="green">143</FONT>         *<a name="line.143"></a>
<FONT color="green">144</FONT>         * @param &lt;V&gt; the type of the values in the map<a name="line.144"></a>
<FONT color="green">145</FONT>         * @param source  the source text containing the variables to substitute, null returns null<a name="line.145"></a>
<FONT color="green">146</FONT>         * @param valueMap  the map with the values, may be null<a name="line.146"></a>
<FONT color="green">147</FONT>         * @return the result of the replace operation<a name="line.147"></a>
<FONT color="green">148</FONT>         */<a name="line.148"></a>
<FONT color="green">149</FONT>        public static &lt;V&gt; String replace(Object source, Map&lt;String, V&gt; valueMap) {<a name="line.149"></a>
<FONT color="green">150</FONT>            return new StrSubstitutor(valueMap).replace(source);<a name="line.150"></a>
<FONT color="green">151</FONT>        }<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>        /**<a name="line.153"></a>
<FONT color="green">154</FONT>         * Replaces all the occurrences of variables in the given source object with<a name="line.154"></a>
<FONT color="green">155</FONT>         * their matching values from the map. This method allows to specifiy a<a name="line.155"></a>
<FONT color="green">156</FONT>         * custom variable prefix and suffix<a name="line.156"></a>
<FONT color="green">157</FONT>         *<a name="line.157"></a>
<FONT color="green">158</FONT>         * @param &lt;V&gt; the type of the values in the map<a name="line.158"></a>
<FONT color="green">159</FONT>         * @param source  the source text containing the variables to substitute, null returns null<a name="line.159"></a>
<FONT color="green">160</FONT>         * @param valueMap  the map with the values, may be null<a name="line.160"></a>
<FONT color="green">161</FONT>         * @param prefix  the prefix of variables, not null<a name="line.161"></a>
<FONT color="green">162</FONT>         * @param suffix  the suffix of variables, not null<a name="line.162"></a>
<FONT color="green">163</FONT>         * @return the result of the replace operation<a name="line.163"></a>
<FONT color="green">164</FONT>         * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.164"></a>
<FONT color="green">165</FONT>         */<a name="line.165"></a>
<FONT color="green">166</FONT>        public static &lt;V&gt; String replace(Object source, Map&lt;String, V&gt; valueMap, String prefix, String suffix) {<a name="line.166"></a>
<FONT color="green">167</FONT>            return new StrSubstitutor(valueMap, prefix, suffix).replace(source);<a name="line.167"></a>
<FONT color="green">168</FONT>        }<a name="line.168"></a>
<FONT color="green">169</FONT>    <a name="line.169"></a>
<FONT color="green">170</FONT>        /**<a name="line.170"></a>
<FONT color="green">171</FONT>         * Replaces all the occurrences of variables in the given source object with their matching<a name="line.171"></a>
<FONT color="green">172</FONT>         * values from the properties.<a name="line.172"></a>
<FONT color="green">173</FONT>         *<a name="line.173"></a>
<FONT color="green">174</FONT>         * @param source the source text containing the variables to substitute, null returns null<a name="line.174"></a>
<FONT color="green">175</FONT>         * @param valueProperties the properties with values, may be null<a name="line.175"></a>
<FONT color="green">176</FONT>         * @return the result of the replace operation<a name="line.176"></a>
<FONT color="green">177</FONT>         */<a name="line.177"></a>
<FONT color="green">178</FONT>        public static String replace(Object source, Properties valueProperties) {<a name="line.178"></a>
<FONT color="green">179</FONT>            if (valueProperties == null) {<a name="line.179"></a>
<FONT color="green">180</FONT>                return source.toString();<a name="line.180"></a>
<FONT color="green">181</FONT>            }<a name="line.181"></a>
<FONT color="green">182</FONT>            Map&lt;String,String&gt; valueMap = new HashMap&lt;String,String&gt;();<a name="line.182"></a>
<FONT color="green">183</FONT>            Enumeration&lt;?&gt; propNames = valueProperties.propertyNames();<a name="line.183"></a>
<FONT color="green">184</FONT>            while (propNames.hasMoreElements()) {<a name="line.184"></a>
<FONT color="green">185</FONT>                String propName = (String)propNames.nextElement();<a name="line.185"></a>
<FONT color="green">186</FONT>                String propValue = valueProperties.getProperty(propName);<a name="line.186"></a>
<FONT color="green">187</FONT>                valueMap.put(propName, propValue);<a name="line.187"></a>
<FONT color="green">188</FONT>            }<a name="line.188"></a>
<FONT color="green">189</FONT>            return StrSubstitutor.replace(source, valueMap);<a name="line.189"></a>
<FONT color="green">190</FONT>        }<a name="line.190"></a>
<FONT color="green">191</FONT>    <a name="line.191"></a>
<FONT color="green">192</FONT>        /**<a name="line.192"></a>
<FONT color="green">193</FONT>         * Replaces all the occurrences of variables in the given source object with<a name="line.193"></a>
<FONT color="green">194</FONT>         * their matching values from the system properties.<a name="line.194"></a>
<FONT color="green">195</FONT>         *<a name="line.195"></a>
<FONT color="green">196</FONT>         * @param source  the source text containing the variables to substitute, null returns null<a name="line.196"></a>
<FONT color="green">197</FONT>         * @return the result of the replace operation<a name="line.197"></a>
<FONT color="green">198</FONT>         */<a name="line.198"></a>
<FONT color="green">199</FONT>        public static String replaceSystemProperties(Object source) {<a name="line.199"></a>
<FONT color="green">200</FONT>            return new StrSubstitutor(StrLookup.systemPropertiesLookup()).replace(source);<a name="line.200"></a>
<FONT color="green">201</FONT>        }<a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>        //-----------------------------------------------------------------------<a name="line.203"></a>
<FONT color="green">204</FONT>        /**<a name="line.204"></a>
<FONT color="green">205</FONT>         * Creates a new instance with defaults for variable prefix and suffix<a name="line.205"></a>
<FONT color="green">206</FONT>         * and the escaping character.<a name="line.206"></a>
<FONT color="green">207</FONT>         */<a name="line.207"></a>
<FONT color="green">208</FONT>        public StrSubstitutor() {<a name="line.208"></a>
<FONT color="green">209</FONT>            this((StrLookup&lt;?&gt;) null, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<a name="line.209"></a>
<FONT color="green">210</FONT>        }<a name="line.210"></a>
<FONT color="green">211</FONT>    <a name="line.211"></a>
<FONT color="green">212</FONT>        /**<a name="line.212"></a>
<FONT color="green">213</FONT>         * Creates a new instance and initializes it. Uses defaults for variable<a name="line.213"></a>
<FONT color="green">214</FONT>         * prefix and suffix and the escaping character.<a name="line.214"></a>
<FONT color="green">215</FONT>         *<a name="line.215"></a>
<FONT color="green">216</FONT>         * @param &lt;V&gt; the type of the values in the map<a name="line.216"></a>
<FONT color="green">217</FONT>         * @param valueMap  the map with the variables' values, may be null<a name="line.217"></a>
<FONT color="green">218</FONT>         */<a name="line.218"></a>
<FONT color="green">219</FONT>        public &lt;V&gt; StrSubstitutor(Map&lt;String, V&gt; valueMap) {<a name="line.219"></a>
<FONT color="green">220</FONT>            this(StrLookup.mapLookup(valueMap), DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<a name="line.220"></a>
<FONT color="green">221</FONT>        }<a name="line.221"></a>
<FONT color="green">222</FONT>    <a name="line.222"></a>
<FONT color="green">223</FONT>        /**<a name="line.223"></a>
<FONT color="green">224</FONT>         * Creates a new instance and initializes it. Uses a default escaping character.<a name="line.224"></a>
<FONT color="green">225</FONT>         *<a name="line.225"></a>
<FONT color="green">226</FONT>         * @param &lt;V&gt; the type of the values in the map<a name="line.226"></a>
<FONT color="green">227</FONT>         * @param valueMap  the map with the variables' values, may be null<a name="line.227"></a>
<FONT color="green">228</FONT>         * @param prefix  the prefix for variables, not null<a name="line.228"></a>
<FONT color="green">229</FONT>         * @param suffix  the suffix for variables, not null<a name="line.229"></a>
<FONT color="green">230</FONT>         * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.230"></a>
<FONT color="green">231</FONT>         */<a name="line.231"></a>
<FONT color="green">232</FONT>        public &lt;V&gt; StrSubstitutor(Map&lt;String, V&gt; valueMap, String prefix, String suffix) {<a name="line.232"></a>
<FONT color="green">233</FONT>            this(StrLookup.mapLookup(valueMap), prefix, suffix, DEFAULT_ESCAPE);<a name="line.233"></a>
<FONT color="green">234</FONT>        }<a name="line.234"></a>
<FONT color="green">235</FONT>    <a name="line.235"></a>
<FONT color="green">236</FONT>        /**<a name="line.236"></a>
<FONT color="green">237</FONT>         * Creates a new instance and initializes it.<a name="line.237"></a>
<FONT color="green">238</FONT>         *<a name="line.238"></a>
<FONT color="green">239</FONT>         * @param &lt;V&gt; the type of the values in the map<a name="line.239"></a>
<FONT color="green">240</FONT>         * @param valueMap  the map with the variables' values, may be null<a name="line.240"></a>
<FONT color="green">241</FONT>         * @param prefix  the prefix for variables, not null<a name="line.241"></a>
<FONT color="green">242</FONT>         * @param suffix  the suffix for variables, not null<a name="line.242"></a>
<FONT color="green">243</FONT>         * @param escape  the escape character<a name="line.243"></a>
<FONT color="green">244</FONT>         * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.244"></a>
<FONT color="green">245</FONT>         */<a name="line.245"></a>
<FONT color="green">246</FONT>        public &lt;V&gt; StrSubstitutor(Map&lt;String, V&gt; valueMap, String prefix, String suffix, char escape) {<a name="line.246"></a>
<FONT color="green">247</FONT>            this(StrLookup.mapLookup(valueMap), prefix, suffix, escape);<a name="line.247"></a>
<FONT color="green">248</FONT>        }<a name="line.248"></a>
<FONT color="green">249</FONT>    <a name="line.249"></a>
<FONT color="green">250</FONT>        /**<a name="line.250"></a>
<FONT color="green">251</FONT>         * Creates a new instance and initializes it.<a name="line.251"></a>
<FONT color="green">252</FONT>         *<a name="line.252"></a>
<FONT color="green">253</FONT>         * @param variableResolver  the variable resolver, may be null<a name="line.253"></a>
<FONT color="green">254</FONT>         */<a name="line.254"></a>
<FONT color="green">255</FONT>        public StrSubstitutor(StrLookup&lt;?&gt; variableResolver) {<a name="line.255"></a>
<FONT color="green">256</FONT>            this(variableResolver, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<a name="line.256"></a>
<FONT color="green">257</FONT>        }<a name="line.257"></a>
<FONT color="green">258</FONT>    <a name="line.258"></a>
<FONT color="green">259</FONT>        /**<a name="line.259"></a>
<FONT color="green">260</FONT>         * Creates a new instance and initializes it.<a name="line.260"></a>
<FONT color="green">261</FONT>         *<a name="line.261"></a>
<FONT color="green">262</FONT>         * @param variableResolver  the variable resolver, may be null<a name="line.262"></a>
<FONT color="green">263</FONT>         * @param prefix  the prefix for variables, not null<a name="line.263"></a>
<FONT color="green">264</FONT>         * @param suffix  the suffix for variables, not null<a name="line.264"></a>
<FONT color="green">265</FONT>         * @param escape  the escape character<a name="line.265"></a>
<FONT color="green">266</FONT>         * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.266"></a>
<FONT color="green">267</FONT>         */<a name="line.267"></a>
<FONT color="green">268</FONT>        public StrSubstitutor(StrLookup&lt;?&gt; variableResolver, String prefix, String suffix, char escape) {<a name="line.268"></a>
<FONT color="green">269</FONT>            this.setVariableResolver(variableResolver);<a name="line.269"></a>
<FONT color="green">270</FONT>            this.setVariablePrefix(prefix);<a name="line.270"></a>
<FONT color="green">271</FONT>            this.setVariableSuffix(suffix);<a name="line.271"></a>
<FONT color="green">272</FONT>            this.setEscapeChar(escape);<a name="line.272"></a>
<FONT color="green">273</FONT>        }<a name="line.273"></a>
<FONT color="green">274</FONT>    <a name="line.274"></a>
<FONT color="green">275</FONT>        /**<a name="line.275"></a>
<FONT color="green">276</FONT>         * Creates a new instance and initializes it.<a name="line.276"></a>
<FONT color="green">277</FONT>         *<a name="line.277"></a>
<FONT color="green">278</FONT>         * @param variableResolver  the variable resolver, may be null<a name="line.278"></a>
<FONT color="green">279</FONT>         * @param prefixMatcher  the prefix for variables, not null<a name="line.279"></a>
<FONT color="green">280</FONT>         * @param suffixMatcher  the suffix for variables, not null<a name="line.280"></a>
<FONT color="green">281</FONT>         * @param escape  the escape character<a name="line.281"></a>
<FONT color="green">282</FONT>         * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.282"></a>
<FONT color="green">283</FONT>         */<a name="line.283"></a>
<FONT color="green">284</FONT>        public StrSubstitutor(<a name="line.284"></a>
<FONT color="green">285</FONT>                StrLookup&lt;?&gt; variableResolver, StrMatcher prefixMatcher, StrMatcher suffixMatcher, char escape) {<a name="line.285"></a>
<FONT color="green">286</FONT>            this.setVariableResolver(variableResolver);<a name="line.286"></a>
<FONT color="green">287</FONT>            this.setVariablePrefixMatcher(prefixMatcher);<a name="line.287"></a>
<FONT color="green">288</FONT>            this.setVariableSuffixMatcher(suffixMatcher);<a name="line.288"></a>
<FONT color="green">289</FONT>            this.setEscapeChar(escape);<a name="line.289"></a>
<FONT color="green">290</FONT>        }<a name="line.290"></a>
<FONT color="green">291</FONT>    <a name="line.291"></a>
<FONT color="green">292</FONT>        //-----------------------------------------------------------------------<a name="line.292"></a>
<FONT color="green">293</FONT>        /**<a name="line.293"></a>
<FONT color="green">294</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.294"></a>
<FONT color="green">295</FONT>         * from the resolver using the given source string as a template.<a name="line.295"></a>
<FONT color="green">296</FONT>         *<a name="line.296"></a>
<FONT color="green">297</FONT>         * @param source  the string to replace in, null returns null<a name="line.297"></a>
<FONT color="green">298</FONT>         * @return the result of the replace operation<a name="line.298"></a>
<FONT color="green">299</FONT>         */<a name="line.299"></a>
<FONT color="green">300</FONT>        public String replace(String source) {<a name="line.300"></a>
<FONT color="green">301</FONT>            if (source == null) {<a name="line.301"></a>
<FONT color="green">302</FONT>                return null;<a name="line.302"></a>
<FONT color="green">303</FONT>            }<a name="line.303"></a>
<FONT color="green">304</FONT>            StrBuilder buf = new StrBuilder(source);<a name="line.304"></a>
<FONT color="green">305</FONT>            if (substitute(buf, 0, source.length()) == false) {<a name="line.305"></a>
<FONT color="green">306</FONT>                return source;<a name="line.306"></a>
<FONT color="green">307</FONT>            }<a name="line.307"></a>
<FONT color="green">308</FONT>            return buf.toString();<a name="line.308"></a>
<FONT color="green">309</FONT>        }<a name="line.309"></a>
<FONT color="green">310</FONT>    <a name="line.310"></a>
<FONT color="green">311</FONT>        /**<a name="line.311"></a>
<FONT color="green">312</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.312"></a>
<FONT color="green">313</FONT>         * from the resolver using the given source string as a template.<a name="line.313"></a>
<FONT color="green">314</FONT>         * &lt;p&gt;<a name="line.314"></a>
<FONT color="green">315</FONT>         * Only the specified portion of the string will be processed.<a name="line.315"></a>
<FONT color="green">316</FONT>         * The rest of the string is not processed, and is not returned.<a name="line.316"></a>
<FONT color="green">317</FONT>         *<a name="line.317"></a>
<FONT color="green">318</FONT>         * @param source  the string to replace in, null returns null<a name="line.318"></a>
<FONT color="green">319</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.319"></a>
<FONT color="green">320</FONT>         * @param length  the length within the array to be processed, must be valid<a name="line.320"></a>
<FONT color="green">321</FONT>         * @return the result of the replace operation<a name="line.321"></a>
<FONT color="green">322</FONT>         */<a name="line.322"></a>
<FONT color="green">323</FONT>        public String replace(String source, int offset, int length) {<a name="line.323"></a>
<FONT color="green">324</FONT>            if (source == null) {<a name="line.324"></a>
<FONT color="green">325</FONT>                return null;<a name="line.325"></a>
<FONT color="green">326</FONT>            }<a name="line.326"></a>
<FONT color="green">327</FONT>            StrBuilder buf = new StrBuilder(length).append(source, offset, length);<a name="line.327"></a>
<FONT color="green">328</FONT>            if (substitute(buf, 0, length) == false) {<a name="line.328"></a>
<FONT color="green">329</FONT>                return source.substring(offset, offset + length);<a name="line.329"></a>
<FONT color="green">330</FONT>            }<a name="line.330"></a>
<FONT color="green">331</FONT>            return buf.toString();<a name="line.331"></a>
<FONT color="green">332</FONT>        }<a name="line.332"></a>
<FONT color="green">333</FONT>    <a name="line.333"></a>
<FONT color="green">334</FONT>        //-----------------------------------------------------------------------<a name="line.334"></a>
<FONT color="green">335</FONT>        /**<a name="line.335"></a>
<FONT color="green">336</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.336"></a>
<FONT color="green">337</FONT>         * from the resolver using the given source array as a template.<a name="line.337"></a>
<FONT color="green">338</FONT>         * The array is not altered by this method.<a name="line.338"></a>
<FONT color="green">339</FONT>         *<a name="line.339"></a>
<FONT color="green">340</FONT>         * @param source  the character array to replace in, not altered, null returns null<a name="line.340"></a>
<FONT color="green">341</FONT>         * @return the result of the replace operation<a name="line.341"></a>
<FONT color="green">342</FONT>         */<a name="line.342"></a>
<FONT color="green">343</FONT>        public String replace(char[] source) {<a name="line.343"></a>
<FONT color="green">344</FONT>            if (source == null) {<a name="line.344"></a>
<FONT color="green">345</FONT>                return null;<a name="line.345"></a>
<FONT color="green">346</FONT>            }<a name="line.346"></a>
<FONT color="green">347</FONT>            StrBuilder buf = new StrBuilder(source.length).append(source);<a name="line.347"></a>
<FONT color="green">348</FONT>            substitute(buf, 0, source.length);<a name="line.348"></a>
<FONT color="green">349</FONT>            return buf.toString();<a name="line.349"></a>
<FONT color="green">350</FONT>        }<a name="line.350"></a>
<FONT color="green">351</FONT>    <a name="line.351"></a>
<FONT color="green">352</FONT>        /**<a name="line.352"></a>
<FONT color="green">353</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.353"></a>
<FONT color="green">354</FONT>         * from the resolver using the given source array as a template.<a name="line.354"></a>
<FONT color="green">355</FONT>         * The array is not altered by this method.<a name="line.355"></a>
<FONT color="green">356</FONT>         * &lt;p&gt;<a name="line.356"></a>
<FONT color="green">357</FONT>         * Only the specified portion of the array will be processed.<a name="line.357"></a>
<FONT color="green">358</FONT>         * The rest of the array is not processed, and is not returned.<a name="line.358"></a>
<FONT color="green">359</FONT>         *<a name="line.359"></a>
<FONT color="green">360</FONT>         * @param source  the character array to replace in, not altered, null returns null<a name="line.360"></a>
<FONT color="green">361</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.361"></a>
<FONT color="green">362</FONT>         * @param length  the length within the array to be processed, must be valid<a name="line.362"></a>
<FONT color="green">363</FONT>         * @return the result of the replace operation<a name="line.363"></a>
<FONT color="green">364</FONT>         */<a name="line.364"></a>
<FONT color="green">365</FONT>        public String replace(char[] source, int offset, int length) {<a name="line.365"></a>
<FONT color="green">366</FONT>            if (source == null) {<a name="line.366"></a>
<FONT color="green">367</FONT>                return null;<a name="line.367"></a>
<FONT color="green">368</FONT>            }<a name="line.368"></a>
<FONT color="green">369</FONT>            StrBuilder buf = new StrBuilder(length).append(source, offset, length);<a name="line.369"></a>
<FONT color="green">370</FONT>            substitute(buf, 0, length);<a name="line.370"></a>
<FONT color="green">371</FONT>            return buf.toString();<a name="line.371"></a>
<FONT color="green">372</FONT>        }<a name="line.372"></a>
<FONT color="green">373</FONT>    <a name="line.373"></a>
<FONT color="green">374</FONT>        //-----------------------------------------------------------------------<a name="line.374"></a>
<FONT color="green">375</FONT>        /**<a name="line.375"></a>
<FONT color="green">376</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.376"></a>
<FONT color="green">377</FONT>         * from the resolver using the given source buffer as a template.<a name="line.377"></a>
<FONT color="green">378</FONT>         * The buffer is not altered by this method.<a name="line.378"></a>
<FONT color="green">379</FONT>         *<a name="line.379"></a>
<FONT color="green">380</FONT>         * @param source  the buffer to use as a template, not changed, null returns null<a name="line.380"></a>
<FONT color="green">381</FONT>         * @return the result of the replace operation<a name="line.381"></a>
<FONT color="green">382</FONT>         */<a name="line.382"></a>
<FONT color="green">383</FONT>        public String replace(StringBuffer source) {<a name="line.383"></a>
<FONT color="green">384</FONT>            if (source == null) {<a name="line.384"></a>
<FONT color="green">385</FONT>                return null;<a name="line.385"></a>
<FONT color="green">386</FONT>            }<a name="line.386"></a>
<FONT color="green">387</FONT>            StrBuilder buf = new StrBuilder(source.length()).append(source);<a name="line.387"></a>
<FONT color="green">388</FONT>            substitute(buf, 0, buf.length());<a name="line.388"></a>
<FONT color="green">389</FONT>            return buf.toString();<a name="line.389"></a>
<FONT color="green">390</FONT>        }<a name="line.390"></a>
<FONT color="green">391</FONT>    <a name="line.391"></a>
<FONT color="green">392</FONT>        /**<a name="line.392"></a>
<FONT color="green">393</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.393"></a>
<FONT color="green">394</FONT>         * from the resolver using the given source buffer as a template.<a name="line.394"></a>
<FONT color="green">395</FONT>         * The buffer is not altered by this method.<a name="line.395"></a>
<FONT color="green">396</FONT>         * &lt;p&gt;<a name="line.396"></a>
<FONT color="green">397</FONT>         * Only the specified portion of the buffer will be processed.<a name="line.397"></a>
<FONT color="green">398</FONT>         * The rest of the buffer is not processed, and is not returned.<a name="line.398"></a>
<FONT color="green">399</FONT>         *<a name="line.399"></a>
<FONT color="green">400</FONT>         * @param source  the buffer to use as a template, not changed, null returns null<a name="line.400"></a>
<FONT color="green">401</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.401"></a>
<FONT color="green">402</FONT>         * @param length  the length within the array to be processed, must be valid<a name="line.402"></a>
<FONT color="green">403</FONT>         * @return the result of the replace operation<a name="line.403"></a>
<FONT color="green">404</FONT>         */<a name="line.404"></a>
<FONT color="green">405</FONT>        public String replace(StringBuffer source, int offset, int length) {<a name="line.405"></a>
<FONT color="green">406</FONT>            if (source == null) {<a name="line.406"></a>
<FONT color="green">407</FONT>                return null;<a name="line.407"></a>
<FONT color="green">408</FONT>            }<a name="line.408"></a>
<FONT color="green">409</FONT>            StrBuilder buf = new StrBuilder(length).append(source, offset, length);<a name="line.409"></a>
<FONT color="green">410</FONT>            substitute(buf, 0, length);<a name="line.410"></a>
<FONT color="green">411</FONT>            return buf.toString();<a name="line.411"></a>
<FONT color="green">412</FONT>        }<a name="line.412"></a>
<FONT color="green">413</FONT>    <a name="line.413"></a>
<FONT color="green">414</FONT>        //-----------------------------------------------------------------------<a name="line.414"></a>
<FONT color="green">415</FONT>        /**<a name="line.415"></a>
<FONT color="green">416</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.416"></a>
<FONT color="green">417</FONT>         * from the resolver using the given source builder as a template.<a name="line.417"></a>
<FONT color="green">418</FONT>         * The builder is not altered by this method.<a name="line.418"></a>
<FONT color="green">419</FONT>         *<a name="line.419"></a>
<FONT color="green">420</FONT>         * @param source  the builder to use as a template, not changed, null returns null<a name="line.420"></a>
<FONT color="green">421</FONT>         * @return the result of the replace operation<a name="line.421"></a>
<FONT color="green">422</FONT>         */<a name="line.422"></a>
<FONT color="green">423</FONT>        public String replace(StrBuilder source) {<a name="line.423"></a>
<FONT color="green">424</FONT>            if (source == null) {<a name="line.424"></a>
<FONT color="green">425</FONT>                return null;<a name="line.425"></a>
<FONT color="green">426</FONT>            }<a name="line.426"></a>
<FONT color="green">427</FONT>            StrBuilder buf = new StrBuilder(source.length()).append(source);<a name="line.427"></a>
<FONT color="green">428</FONT>            substitute(buf, 0, buf.length());<a name="line.428"></a>
<FONT color="green">429</FONT>            return buf.toString();<a name="line.429"></a>
<FONT color="green">430</FONT>        }<a name="line.430"></a>
<FONT color="green">431</FONT>    <a name="line.431"></a>
<FONT color="green">432</FONT>        /**<a name="line.432"></a>
<FONT color="green">433</FONT>         * Replaces all the occurrences of variables with their matching values<a name="line.433"></a>
<FONT color="green">434</FONT>         * from the resolver using the given source builder as a template.<a name="line.434"></a>
<FONT color="green">435</FONT>         * The builder is not altered by this method.<a name="line.435"></a>
<FONT color="green">436</FONT>         * &lt;p&gt;<a name="line.436"></a>
<FONT color="green">437</FONT>         * Only the specified portion of the builder will be processed.<a name="line.437"></a>
<FONT color="green">438</FONT>         * The rest of the builder is not processed, and is not returned.<a name="line.438"></a>
<FONT color="green">439</FONT>         *<a name="line.439"></a>
<FONT color="green">440</FONT>         * @param source  the builder to use as a template, not changed, null returns null<a name="line.440"></a>
<FONT color="green">441</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.441"></a>
<FONT color="green">442</FONT>         * @param length  the length within the array to be processed, must be valid<a name="line.442"></a>
<FONT color="green">443</FONT>         * @return the result of the replace operation<a name="line.443"></a>
<FONT color="green">444</FONT>         */<a name="line.444"></a>
<FONT color="green">445</FONT>        public String replace(StrBuilder source, int offset, int length) {<a name="line.445"></a>
<FONT color="green">446</FONT>            if (source == null) {<a name="line.446"></a>
<FONT color="green">447</FONT>                return null;<a name="line.447"></a>
<FONT color="green">448</FONT>            }<a name="line.448"></a>
<FONT color="green">449</FONT>            StrBuilder buf = new StrBuilder(length).append(source, offset, length);<a name="line.449"></a>
<FONT color="green">450</FONT>            substitute(buf, 0, length);<a name="line.450"></a>
<FONT color="green">451</FONT>            return buf.toString();<a name="line.451"></a>
<FONT color="green">452</FONT>        }<a name="line.452"></a>
<FONT color="green">453</FONT>    <a name="line.453"></a>
<FONT color="green">454</FONT>        //-----------------------------------------------------------------------<a name="line.454"></a>
<FONT color="green">455</FONT>        /**<a name="line.455"></a>
<FONT color="green">456</FONT>         * Replaces all the occurrences of variables in the given source object with<a name="line.456"></a>
<FONT color="green">457</FONT>         * their matching values from the resolver. The input source object is<a name="line.457"></a>
<FONT color="green">458</FONT>         * converted to a string using &lt;code&gt;toString&lt;/code&gt; and is not altered.<a name="line.458"></a>
<FONT color="green">459</FONT>         *<a name="line.459"></a>
<FONT color="green">460</FONT>         * @param source  the source to replace in, null returns null<a name="line.460"></a>
<FONT color="green">461</FONT>         * @return the result of the replace operation<a name="line.461"></a>
<FONT color="green">462</FONT>         */<a name="line.462"></a>
<FONT color="green">463</FONT>        public String replace(Object source) {<a name="line.463"></a>
<FONT color="green">464</FONT>            if (source == null) {<a name="line.464"></a>
<FONT color="green">465</FONT>                return null;<a name="line.465"></a>
<FONT color="green">466</FONT>            }<a name="line.466"></a>
<FONT color="green">467</FONT>            StrBuilder buf = new StrBuilder().append(source);<a name="line.467"></a>
<FONT color="green">468</FONT>            substitute(buf, 0, buf.length());<a name="line.468"></a>
<FONT color="green">469</FONT>            return buf.toString();<a name="line.469"></a>
<FONT color="green">470</FONT>        }<a name="line.470"></a>
<FONT color="green">471</FONT>    <a name="line.471"></a>
<FONT color="green">472</FONT>        //-----------------------------------------------------------------------<a name="line.472"></a>
<FONT color="green">473</FONT>        /**<a name="line.473"></a>
<FONT color="green">474</FONT>         * Replaces all the occurrences of variables within the given source buffer<a name="line.474"></a>
<FONT color="green">475</FONT>         * with their matching values from the resolver.<a name="line.475"></a>
<FONT color="green">476</FONT>         * The buffer is updated with the result.<a name="line.476"></a>
<FONT color="green">477</FONT>         *<a name="line.477"></a>
<FONT color="green">478</FONT>         * @param source  the buffer to replace in, updated, null returns zero<a name="line.478"></a>
<FONT color="green">479</FONT>         * @return true if altered<a name="line.479"></a>
<FONT color="green">480</FONT>         */<a name="line.480"></a>
<FONT color="green">481</FONT>        public boolean replaceIn(StringBuffer source) {<a name="line.481"></a>
<FONT color="green">482</FONT>            if (source == null) {<a name="line.482"></a>
<FONT color="green">483</FONT>                return false;<a name="line.483"></a>
<FONT color="green">484</FONT>            }<a name="line.484"></a>
<FONT color="green">485</FONT>            return replaceIn(source, 0, source.length());<a name="line.485"></a>
<FONT color="green">486</FONT>        }<a name="line.486"></a>
<FONT color="green">487</FONT>    <a name="line.487"></a>
<FONT color="green">488</FONT>        /**<a name="line.488"></a>
<FONT color="green">489</FONT>         * Replaces all the occurrences of variables within the given source buffer<a name="line.489"></a>
<FONT color="green">490</FONT>         * with their matching values from the resolver.<a name="line.490"></a>
<FONT color="green">491</FONT>         * The buffer is updated with the result.<a name="line.491"></a>
<FONT color="green">492</FONT>         * &lt;p&gt;<a name="line.492"></a>
<FONT color="green">493</FONT>         * Only the specified portion of the buffer will be processed.<a name="line.493"></a>
<FONT color="green">494</FONT>         * The rest of the buffer is not processed, but it is not deleted.<a name="line.494"></a>
<FONT color="green">495</FONT>         *<a name="line.495"></a>
<FONT color="green">496</FONT>         * @param source  the buffer to replace in, updated, null returns zero<a name="line.496"></a>
<FONT color="green">497</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.497"></a>
<FONT color="green">498</FONT>         * @param length  the length within the buffer to be processed, must be valid<a name="line.498"></a>
<FONT color="green">499</FONT>         * @return true if altered<a name="line.499"></a>
<FONT color="green">500</FONT>         */<a name="line.500"></a>
<FONT color="green">501</FONT>        public boolean replaceIn(StringBuffer source, int offset, int length) {<a name="line.501"></a>
<FONT color="green">502</FONT>            if (source == null) {<a name="line.502"></a>
<FONT color="green">503</FONT>                return false;<a name="line.503"></a>
<FONT color="green">504</FONT>            }<a name="line.504"></a>
<FONT color="green">505</FONT>            StrBuilder buf = new StrBuilder(length).append(source, offset, length);<a name="line.505"></a>
<FONT color="green">506</FONT>            if (substitute(buf, 0, length) == false) {<a name="line.506"></a>
<FONT color="green">507</FONT>                return false;<a name="line.507"></a>
<FONT color="green">508</FONT>            }<a name="line.508"></a>
<FONT color="green">509</FONT>            source.replace(offset, offset + length, buf.toString());<a name="line.509"></a>
<FONT color="green">510</FONT>            return true;<a name="line.510"></a>
<FONT color="green">511</FONT>        }<a name="line.511"></a>
<FONT color="green">512</FONT>    <a name="line.512"></a>
<FONT color="green">513</FONT>        //-----------------------------------------------------------------------<a name="line.513"></a>
<FONT color="green">514</FONT>        /**<a name="line.514"></a>
<FONT color="green">515</FONT>         * Replaces all the occurrences of variables within the given source<a name="line.515"></a>
<FONT color="green">516</FONT>         * builder with their matching values from the resolver.<a name="line.516"></a>
<FONT color="green">517</FONT>         *<a name="line.517"></a>
<FONT color="green">518</FONT>         * @param source  the builder to replace in, updated, null returns zero<a name="line.518"></a>
<FONT color="green">519</FONT>         * @return true if altered<a name="line.519"></a>
<FONT color="green">520</FONT>         */<a name="line.520"></a>
<FONT color="green">521</FONT>        public boolean replaceIn(StrBuilder source) {<a name="line.521"></a>
<FONT color="green">522</FONT>            if (source == null) {<a name="line.522"></a>
<FONT color="green">523</FONT>                return false;<a name="line.523"></a>
<FONT color="green">524</FONT>            }<a name="line.524"></a>
<FONT color="green">525</FONT>            return substitute(source, 0, source.length());<a name="line.525"></a>
<FONT color="green">526</FONT>        }<a name="line.526"></a>
<FONT color="green">527</FONT>    <a name="line.527"></a>
<FONT color="green">528</FONT>        /**<a name="line.528"></a>
<FONT color="green">529</FONT>         * Replaces all the occurrences of variables within the given source<a name="line.529"></a>
<FONT color="green">530</FONT>         * builder with their matching values from the resolver.<a name="line.530"></a>
<FONT color="green">531</FONT>         * &lt;p&gt;<a name="line.531"></a>
<FONT color="green">532</FONT>         * Only the specified portion of the builder will be processed.<a name="line.532"></a>
<FONT color="green">533</FONT>         * The rest of the builder is not processed, but it is not deleted.<a name="line.533"></a>
<FONT color="green">534</FONT>         *<a name="line.534"></a>
<FONT color="green">535</FONT>         * @param source  the builder to replace in, null returns zero<a name="line.535"></a>
<FONT color="green">536</FONT>         * @param offset  the start offset within the array, must be valid<a name="line.536"></a>
<FONT color="green">537</FONT>         * @param length  the length within the builder to be processed, must be valid<a name="line.537"></a>
<FONT color="green">538</FONT>         * @return true if altered<a name="line.538"></a>
<FONT color="green">539</FONT>         */<a name="line.539"></a>
<FONT color="green">540</FONT>        public boolean replaceIn(StrBuilder source, int offset, int length) {<a name="line.540"></a>
<FONT color="green">541</FONT>            if (source == null) {<a name="line.541"></a>
<FONT color="green">542</FONT>                return false;<a name="line.542"></a>
<FONT color="green">543</FONT>            }<a name="line.543"></a>
<FONT color="green">544</FONT>            return substitute(source, offset, length);<a name="line.544"></a>
<FONT color="green">545</FONT>        }<a name="line.545"></a>
<FONT color="green">546</FONT>    <a name="line.546"></a>
<FONT color="green">547</FONT>        //-----------------------------------------------------------------------<a name="line.547"></a>
<FONT color="green">548</FONT>        /**<a name="line.548"></a>
<FONT color="green">549</FONT>         * Internal method that substitutes the variables.<a name="line.549"></a>
<FONT color="green">550</FONT>         * &lt;p&gt;<a name="line.550"></a>
<FONT color="green">551</FONT>         * Most users of this class do not need to call this method. This method will<a name="line.551"></a>
<FONT color="green">552</FONT>         * be called automatically by another (public) method.<a name="line.552"></a>
<FONT color="green">553</FONT>         * &lt;p&gt;<a name="line.553"></a>
<FONT color="green">554</FONT>         * Writers of subclasses can override this method if they need access to<a name="line.554"></a>
<FONT color="green">555</FONT>         * the substitution process at the start or end.<a name="line.555"></a>
<FONT color="green">556</FONT>         *<a name="line.556"></a>
<FONT color="green">557</FONT>         * @param buf  the string builder to substitute into, not null<a name="line.557"></a>
<FONT color="green">558</FONT>         * @param offset  the start offset within the builder, must be valid<a name="line.558"></a>
<FONT color="green">559</FONT>         * @param length  the length within the builder to be processed, must be valid<a name="line.559"></a>
<FONT color="green">560</FONT>         * @return true if altered<a name="line.560"></a>
<FONT color="green">561</FONT>         */<a name="line.561"></a>
<FONT color="green">562</FONT>        protected boolean substitute(StrBuilder buf, int offset, int length) {<a name="line.562"></a>
<FONT color="green">563</FONT>            return substitute(buf, offset, length, null) &gt; 0;<a name="line.563"></a>
<FONT color="green">564</FONT>        }<a name="line.564"></a>
<FONT color="green">565</FONT>    <a name="line.565"></a>
<FONT color="green">566</FONT>        /**<a name="line.566"></a>
<FONT color="green">567</FONT>         * Recursive handler for multiple levels of interpolation. This is the main<a name="line.567"></a>
<FONT color="green">568</FONT>         * interpolation method, which resolves the values of all variable references<a name="line.568"></a>
<FONT color="green">569</FONT>         * contained in the passed in text.<a name="line.569"></a>
<FONT color="green">570</FONT>         *<a name="line.570"></a>
<FONT color="green">571</FONT>         * @param buf  the string builder to substitute into, not null<a name="line.571"></a>
<FONT color="green">572</FONT>         * @param offset  the start offset within the builder, must be valid<a name="line.572"></a>
<FONT color="green">573</FONT>         * @param length  the length within the builder to be processed, must be valid<a name="line.573"></a>
<FONT color="green">574</FONT>         * @param priorVariables  the stack keeping track of the replaced variables, may be null<a name="line.574"></a>
<FONT color="green">575</FONT>         * @return the length change that occurs, unless priorVariables is null when the int<a name="line.575"></a>
<FONT color="green">576</FONT>         *  represents a boolean flag as to whether any change occurred.<a name="line.576"></a>
<FONT color="green">577</FONT>         */<a name="line.577"></a>
<FONT color="green">578</FONT>        private int substitute(StrBuilder buf, int offset, int length, List&lt;String&gt; priorVariables) {<a name="line.578"></a>
<FONT color="green">579</FONT>            StrMatcher prefixMatcher = getVariablePrefixMatcher();<a name="line.579"></a>
<FONT color="green">580</FONT>            StrMatcher suffixMatcher = getVariableSuffixMatcher();<a name="line.580"></a>
<FONT color="green">581</FONT>            char escape = getEscapeChar();<a name="line.581"></a>
<FONT color="green">582</FONT>    <a name="line.582"></a>
<FONT color="green">583</FONT>            boolean top = priorVariables == null;<a name="line.583"></a>
<FONT color="green">584</FONT>            boolean altered = false;<a name="line.584"></a>
<FONT color="green">585</FONT>            int lengthChange = 0;<a name="line.585"></a>
<FONT color="green">586</FONT>            char[] chars = buf.buffer;<a name="line.586"></a>
<FONT color="green">587</FONT>            int bufEnd = offset + length;<a name="line.587"></a>
<FONT color="green">588</FONT>            int pos = offset;<a name="line.588"></a>
<FONT color="green">589</FONT>            while (pos &lt; bufEnd) {<a name="line.589"></a>
<FONT color="green">590</FONT>                int startMatchLen = prefixMatcher.isMatch(chars, pos, offset,<a name="line.590"></a>
<FONT color="green">591</FONT>                        bufEnd);<a name="line.591"></a>
<FONT color="green">592</FONT>                if (startMatchLen == 0) {<a name="line.592"></a>
<FONT color="green">593</FONT>                    pos++;<a name="line.593"></a>
<FONT color="green">594</FONT>                } else {<a name="line.594"></a>
<FONT color="green">595</FONT>                    // found variable start marker<a name="line.595"></a>
<FONT color="green">596</FONT>                    if (pos &gt; offset &amp;&amp; chars[pos - 1] == escape) {<a name="line.596"></a>
<FONT color="green">597</FONT>                        // escaped<a name="line.597"></a>
<FONT color="green">598</FONT>                        buf.deleteCharAt(pos - 1);<a name="line.598"></a>
<FONT color="green">599</FONT>                        chars = buf.buffer; // in case buffer was altered<a name="line.599"></a>
<FONT color="green">600</FONT>                        lengthChange--;<a name="line.600"></a>
<FONT color="green">601</FONT>                        altered = true;<a name="line.601"></a>
<FONT color="green">602</FONT>                        bufEnd--;<a name="line.602"></a>
<FONT color="green">603</FONT>                    } else {<a name="line.603"></a>
<FONT color="green">604</FONT>                        // find suffix<a name="line.604"></a>
<FONT color="green">605</FONT>                        int startPos = pos;<a name="line.605"></a>
<FONT color="green">606</FONT>                        pos += startMatchLen;<a name="line.606"></a>
<FONT color="green">607</FONT>                        int endMatchLen = 0;<a name="line.607"></a>
<FONT color="green">608</FONT>                        int nestedVarCount = 0;<a name="line.608"></a>
<FONT color="green">609</FONT>                        while (pos &lt; bufEnd) {<a name="line.609"></a>
<FONT color="green">610</FONT>                            if (isEnableSubstitutionInVariables()<a name="line.610"></a>
<FONT color="green">611</FONT>                                    &amp;&amp; (endMatchLen = prefixMatcher.isMatch(chars,<a name="line.611"></a>
<FONT color="green">612</FONT>                                            pos, offset, bufEnd)) != 0) {<a name="line.612"></a>
<FONT color="green">613</FONT>                                // found a nested variable start<a name="line.613"></a>
<FONT color="green">614</FONT>                                nestedVarCount++;<a name="line.614"></a>
<FONT color="green">615</FONT>                                pos += endMatchLen;<a name="line.615"></a>
<FONT color="green">616</FONT>                                continue;<a name="line.616"></a>
<FONT color="green">617</FONT>                            }<a name="line.617"></a>
<FONT color="green">618</FONT>    <a name="line.618"></a>
<FONT color="green">619</FONT>                            endMatchLen = suffixMatcher.isMatch(chars, pos, offset,<a name="line.619"></a>
<FONT color="green">620</FONT>                                    bufEnd);<a name="line.620"></a>
<FONT color="green">621</FONT>                            if (endMatchLen == 0) {<a name="line.621"></a>
<FONT color="green">622</FONT>                                pos++;<a name="line.622"></a>
<FONT color="green">623</FONT>                            } else {<a name="line.623"></a>
<FONT color="green">624</FONT>                                // found variable end marker<a name="line.624"></a>
<FONT color="green">625</FONT>                                if (nestedVarCount == 0) {<a name="line.625"></a>
<FONT color="green">626</FONT>                                    String varName = new String(chars, startPos<a name="line.626"></a>
<FONT color="green">627</FONT>                                            + startMatchLen, pos - startPos<a name="line.627"></a>
<FONT color="green">628</FONT>                                            - startMatchLen);<a name="line.628"></a>
<FONT color="green">629</FONT>                                    if (isEnableSubstitutionInVariables()) {<a name="line.629"></a>
<FONT color="green">630</FONT>                                        StrBuilder bufName = new StrBuilder(varName);<a name="line.630"></a>
<FONT color="green">631</FONT>                                        substitute(bufName, 0, bufName.length());<a name="line.631"></a>
<FONT color="green">632</FONT>                                        varName = bufName.toString();<a name="line.632"></a>
<FONT color="green">633</FONT>                                    }<a name="line.633"></a>
<FONT color="green">634</FONT>                                    pos += endMatchLen;<a name="line.634"></a>
<FONT color="green">635</FONT>                                    int endPos = pos;<a name="line.635"></a>
<FONT color="green">636</FONT>    <a name="line.636"></a>
<FONT color="green">637</FONT>                                    // on the first call initialize priorVariables<a name="line.637"></a>
<FONT color="green">638</FONT>                                    if (priorVariables == null) {<a name="line.638"></a>
<FONT color="green">639</FONT>                                        priorVariables = new ArrayList&lt;String&gt;();<a name="line.639"></a>
<FONT color="green">640</FONT>                                        priorVariables.add(new String(chars,<a name="line.640"></a>
<FONT color="green">641</FONT>                                                offset, length));<a name="line.641"></a>
<FONT color="green">642</FONT>                                    }<a name="line.642"></a>
<FONT color="green">643</FONT>    <a name="line.643"></a>
<FONT color="green">644</FONT>                                    // handle cyclic substitution<a name="line.644"></a>
<FONT color="green">645</FONT>                                    checkCyclicSubstitution(varName, priorVariables);<a name="line.645"></a>
<FONT color="green">646</FONT>                                    priorVariables.add(varName);<a name="line.646"></a>
<FONT color="green">647</FONT>    <a name="line.647"></a>
<FONT color="green">648</FONT>                                    // resolve the variable<a name="line.648"></a>
<FONT color="green">649</FONT>                                    String varValue = resolveVariable(varName, buf,<a name="line.649"></a>
<FONT color="green">650</FONT>                                            startPos, endPos);<a name="line.650"></a>
<FONT color="green">651</FONT>                                    if (varValue != null) {<a name="line.651"></a>
<FONT color="green">652</FONT>                                        // recursive replace<a name="line.652"></a>
<FONT color="green">653</FONT>                                        int varLen = varValue.length();<a name="line.653"></a>
<FONT color="green">654</FONT>                                        buf.replace(startPos, endPos, varValue);<a name="line.654"></a>
<FONT color="green">655</FONT>                                        altered = true;<a name="line.655"></a>
<FONT color="green">656</FONT>                                        int change = substitute(buf, startPos,<a name="line.656"></a>
<FONT color="green">657</FONT>                                                varLen, priorVariables);<a name="line.657"></a>
<FONT color="green">658</FONT>                                        change = change<a name="line.658"></a>
<FONT color="green">659</FONT>                                                + varLen - (endPos - startPos);<a name="line.659"></a>
<FONT color="green">660</FONT>                                        pos += change;<a name="line.660"></a>
<FONT color="green">661</FONT>                                        bufEnd += change;<a name="line.661"></a>
<FONT color="green">662</FONT>                                        lengthChange += change;<a name="line.662"></a>
<FONT color="green">663</FONT>                                        chars = buf.buffer; // in case buffer was<a name="line.663"></a>
<FONT color="green">664</FONT>                                                            // altered<a name="line.664"></a>
<FONT color="green">665</FONT>                                    }<a name="line.665"></a>
<FONT color="green">666</FONT>    <a name="line.666"></a>
<FONT color="green">667</FONT>                                    // remove variable from the cyclic stack<a name="line.667"></a>
<FONT color="green">668</FONT>                                    priorVariables<a name="line.668"></a>
<FONT color="green">669</FONT>                                            .remove(priorVariables.size() - 1);<a name="line.669"></a>
<FONT color="green">670</FONT>                                    break;<a name="line.670"></a>
<FONT color="green">671</FONT>                                } else {<a name="line.671"></a>
<FONT color="green">672</FONT>                                    nestedVarCount--;<a name="line.672"></a>
<FONT color="green">673</FONT>                                    pos += endMatchLen;<a name="line.673"></a>
<FONT color="green">674</FONT>                                }<a name="line.674"></a>
<FONT color="green">675</FONT>                            }<a name="line.675"></a>
<FONT color="green">676</FONT>                        }<a name="line.676"></a>
<FONT color="green">677</FONT>                    }<a name="line.677"></a>
<FONT color="green">678</FONT>                }<a name="line.678"></a>
<FONT color="green">679</FONT>            }<a name="line.679"></a>
<FONT color="green">680</FONT>            if (top) {<a name="line.680"></a>
<FONT color="green">681</FONT>                return altered ? 1 : 0;<a name="line.681"></a>
<FONT color="green">682</FONT>            }<a name="line.682"></a>
<FONT color="green">683</FONT>            return lengthChange;<a name="line.683"></a>
<FONT color="green">684</FONT>        }<a name="line.684"></a>
<FONT color="green">685</FONT>    <a name="line.685"></a>
<FONT color="green">686</FONT>        /**<a name="line.686"></a>
<FONT color="green">687</FONT>         * Checks if the specified variable is already in the stack (list) of variables.<a name="line.687"></a>
<FONT color="green">688</FONT>         *<a name="line.688"></a>
<FONT color="green">689</FONT>         * @param varName  the variable name to check<a name="line.689"></a>
<FONT color="green">690</FONT>         * @param priorVariables  the list of prior variables<a name="line.690"></a>
<FONT color="green">691</FONT>         */<a name="line.691"></a>
<FONT color="green">692</FONT>        private void checkCyclicSubstitution(String varName, List&lt;String&gt; priorVariables) {<a name="line.692"></a>
<FONT color="green">693</FONT>            if (priorVariables.contains(varName) == false) {<a name="line.693"></a>
<FONT color="green">694</FONT>                return;<a name="line.694"></a>
<FONT color="green">695</FONT>            }<a name="line.695"></a>
<FONT color="green">696</FONT>            StrBuilder buf = new StrBuilder(256);<a name="line.696"></a>
<FONT color="green">697</FONT>            buf.append("Infinite loop in property interpolation of ");<a name="line.697"></a>
<FONT color="green">698</FONT>            buf.append(priorVariables.remove(0));<a name="line.698"></a>
<FONT color="green">699</FONT>            buf.append(": ");<a name="line.699"></a>
<FONT color="green">700</FONT>            buf.appendWithSeparators(priorVariables, "-&gt;");<a name="line.700"></a>
<FONT color="green">701</FONT>            throw new IllegalStateException(buf.toString());<a name="line.701"></a>
<FONT color="green">702</FONT>        }<a name="line.702"></a>
<FONT color="green">703</FONT>    <a name="line.703"></a>
<FONT color="green">704</FONT>        /**<a name="line.704"></a>
<FONT color="green">705</FONT>         * Internal method that resolves the value of a variable.<a name="line.705"></a>
<FONT color="green">706</FONT>         * &lt;p&gt;<a name="line.706"></a>
<FONT color="green">707</FONT>         * Most users of this class do not need to call this method. This method is<a name="line.707"></a>
<FONT color="green">708</FONT>         * called automatically by the substitution process.<a name="line.708"></a>
<FONT color="green">709</FONT>         * &lt;p&gt;<a name="line.709"></a>
<FONT color="green">710</FONT>         * Writers of subclasses can override this method if they need to alter<a name="line.710"></a>
<FONT color="green">711</FONT>         * how each substitution occurs. The method is passed the variable's name<a name="line.711"></a>
<FONT color="green">712</FONT>         * and must return the corresponding value. This implementation uses the<a name="line.712"></a>
<FONT color="green">713</FONT>         * {@link #getVariableResolver()} with the variable's name as the key.<a name="line.713"></a>
<FONT color="green">714</FONT>         *<a name="line.714"></a>
<FONT color="green">715</FONT>         * @param variableName  the name of the variable, not null<a name="line.715"></a>
<FONT color="green">716</FONT>         * @param buf  the buffer where the substitution is occurring, not null<a name="line.716"></a>
<FONT color="green">717</FONT>         * @param startPos  the start position of the variable including the prefix, valid<a name="line.717"></a>
<FONT color="green">718</FONT>         * @param endPos  the end position of the variable including the suffix, valid<a name="line.718"></a>
<FONT color="green">719</FONT>         * @return the variable's value or &lt;b&gt;null&lt;/b&gt; if the variable is unknown<a name="line.719"></a>
<FONT color="green">720</FONT>         */<a name="line.720"></a>
<FONT color="green">721</FONT>        protected String resolveVariable(String variableName, StrBuilder buf, int startPos, int endPos) {<a name="line.721"></a>
<FONT color="green">722</FONT>            StrLookup&lt;?&gt; resolver = getVariableResolver();<a name="line.722"></a>
<FONT color="green">723</FONT>            if (resolver == null) {<a name="line.723"></a>
<FONT color="green">724</FONT>                return null;<a name="line.724"></a>
<FONT color="green">725</FONT>            }<a name="line.725"></a>
<FONT color="green">726</FONT>            return resolver.lookup(variableName);<a name="line.726"></a>
<FONT color="green">727</FONT>        }<a name="line.727"></a>
<FONT color="green">728</FONT>    <a name="line.728"></a>
<FONT color="green">729</FONT>        // Escape<a name="line.729"></a>
<FONT color="green">730</FONT>        //-----------------------------------------------------------------------<a name="line.730"></a>
<FONT color="green">731</FONT>        /**<a name="line.731"></a>
<FONT color="green">732</FONT>         * Returns the escape character.<a name="line.732"></a>
<FONT color="green">733</FONT>         *<a name="line.733"></a>
<FONT color="green">734</FONT>         * @return the character used for escaping variable references<a name="line.734"></a>
<FONT color="green">735</FONT>         */<a name="line.735"></a>
<FONT color="green">736</FONT>        public char getEscapeChar() {<a name="line.736"></a>
<FONT color="green">737</FONT>            return this.escapeChar;<a name="line.737"></a>
<FONT color="green">738</FONT>        }<a name="line.738"></a>
<FONT color="green">739</FONT>    <a name="line.739"></a>
<FONT color="green">740</FONT>        /**<a name="line.740"></a>
<FONT color="green">741</FONT>         * Sets the escape character.<a name="line.741"></a>
<FONT color="green">742</FONT>         * If this character is placed before a variable reference in the source<a name="line.742"></a>
<FONT color="green">743</FONT>         * text, this variable will be ignored.<a name="line.743"></a>
<FONT color="green">744</FONT>         *<a name="line.744"></a>
<FONT color="green">745</FONT>         * @param escapeCharacter  the escape character (0 for disabling escaping)<a name="line.745"></a>
<FONT color="green">746</FONT>         */<a name="line.746"></a>
<FONT color="green">747</FONT>        public void setEscapeChar(char escapeCharacter) {<a name="line.747"></a>
<FONT color="green">748</FONT>            this.escapeChar = escapeCharacter;<a name="line.748"></a>
<FONT color="green">749</FONT>        }<a name="line.749"></a>
<FONT color="green">750</FONT>    <a name="line.750"></a>
<FONT color="green">751</FONT>        // Prefix<a name="line.751"></a>
<FONT color="green">752</FONT>        //-----------------------------------------------------------------------<a name="line.752"></a>
<FONT color="green">753</FONT>        /**<a name="line.753"></a>
<FONT color="green">754</FONT>         * Gets the variable prefix matcher currently in use.<a name="line.754"></a>
<FONT color="green">755</FONT>         * &lt;p&gt;<a name="line.755"></a>
<FONT color="green">756</FONT>         * The variable prefix is the characer or characters that identify the<a name="line.756"></a>
<FONT color="green">757</FONT>         * start of a variable. This prefix is expressed in terms of a matcher<a name="line.757"></a>
<FONT color="green">758</FONT>         * allowing advanced prefix matches.<a name="line.758"></a>
<FONT color="green">759</FONT>         *<a name="line.759"></a>
<FONT color="green">760</FONT>         * @return the prefix matcher in use<a name="line.760"></a>
<FONT color="green">761</FONT>         */<a name="line.761"></a>
<FONT color="green">762</FONT>        public StrMatcher getVariablePrefixMatcher() {<a name="line.762"></a>
<FONT color="green">763</FONT>            return prefixMatcher;<a name="line.763"></a>
<FONT color="green">764</FONT>        }<a name="line.764"></a>
<FONT color="green">765</FONT>    <a name="line.765"></a>
<FONT color="green">766</FONT>        /**<a name="line.766"></a>
<FONT color="green">767</FONT>         * Sets the variable prefix matcher currently in use.<a name="line.767"></a>
<FONT color="green">768</FONT>         * &lt;p&gt;<a name="line.768"></a>
<FONT color="green">769</FONT>         * The variable prefix is the characer or characters that identify the<a name="line.769"></a>
<FONT color="green">770</FONT>         * start of a variable. This prefix is expressed in terms of a matcher<a name="line.770"></a>
<FONT color="green">771</FONT>         * allowing advanced prefix matches.<a name="line.771"></a>
<FONT color="green">772</FONT>         *<a name="line.772"></a>
<FONT color="green">773</FONT>         * @param prefixMatcher  the prefix matcher to use, null ignored<a name="line.773"></a>
<FONT color="green">774</FONT>         * @return this, to enable chaining<a name="line.774"></a>
<FONT color="green">775</FONT>         * @throws IllegalArgumentException if the prefix matcher is null<a name="line.775"></a>
<FONT color="green">776</FONT>         */<a name="line.776"></a>
<FONT color="green">777</FONT>        public StrSubstitutor setVariablePrefixMatcher(StrMatcher prefixMatcher) {<a name="line.777"></a>
<FONT color="green">778</FONT>            if (prefixMatcher == null) {<a name="line.778"></a>
<FONT color="green">779</FONT>                throw new IllegalArgumentException("Variable prefix matcher must not be null!");<a name="line.779"></a>
<FONT color="green">780</FONT>            }<a name="line.780"></a>
<FONT color="green">781</FONT>            this.prefixMatcher = prefixMatcher;<a name="line.781"></a>
<FONT color="green">782</FONT>            return this;<a name="line.782"></a>
<FONT color="green">783</FONT>        }<a name="line.783"></a>
<FONT color="green">784</FONT>    <a name="line.784"></a>
<FONT color="green">785</FONT>        /**<a name="line.785"></a>
<FONT color="green">786</FONT>         * Sets the variable prefix to use.<a name="line.786"></a>
<FONT color="green">787</FONT>         * &lt;p&gt;<a name="line.787"></a>
<FONT color="green">788</FONT>         * The variable prefix is the character or characters that identify the<a name="line.788"></a>
<FONT color="green">789</FONT>         * start of a variable. This method allows a single character prefix to<a name="line.789"></a>
<FONT color="green">790</FONT>         * be easily set.<a name="line.790"></a>
<FONT color="green">791</FONT>         *<a name="line.791"></a>
<FONT color="green">792</FONT>         * @param prefix  the prefix character to use<a name="line.792"></a>
<FONT color="green">793</FONT>         * @return this, to enable chaining<a name="line.793"></a>
<FONT color="green">794</FONT>         */<a name="line.794"></a>
<FONT color="green">795</FONT>        public StrSubstitutor setVariablePrefix(char prefix) {<a name="line.795"></a>
<FONT color="green">796</FONT>            return setVariablePrefixMatcher(StrMatcher.charMatcher(prefix));<a name="line.796"></a>
<FONT color="green">797</FONT>        }<a name="line.797"></a>
<FONT color="green">798</FONT>    <a name="line.798"></a>
<FONT color="green">799</FONT>        /**<a name="line.799"></a>
<FONT color="green">800</FONT>         * Sets the variable prefix to use.<a name="line.800"></a>
<FONT color="green">801</FONT>         * &lt;p&gt;<a name="line.801"></a>
<FONT color="green">802</FONT>         * The variable prefix is the characer or characters that identify the<a name="line.802"></a>
<FONT color="green">803</FONT>         * start of a variable. This method allows a string prefix to be easily set.<a name="line.803"></a>
<FONT color="green">804</FONT>         *<a name="line.804"></a>
<FONT color="green">805</FONT>         * @param prefix  the prefix for variables, not null<a name="line.805"></a>
<FONT color="green">806</FONT>         * @return this, to enable chaining<a name="line.806"></a>
<FONT color="green">807</FONT>         * @throws IllegalArgumentException if the prefix is null<a name="line.807"></a>
<FONT color="green">808</FONT>         */<a name="line.808"></a>
<FONT color="green">809</FONT>        public StrSubstitutor setVariablePrefix(String prefix) {<a name="line.809"></a>
<FONT color="green">810</FONT>           if (prefix == null) {<a name="line.810"></a>
<FONT color="green">811</FONT>                throw new IllegalArgumentException("Variable prefix must not be null!");<a name="line.811"></a>
<FONT color="green">812</FONT>            }<a name="line.812"></a>
<FONT color="green">813</FONT>            return setVariablePrefixMatcher(StrMatcher.stringMatcher(prefix));<a name="line.813"></a>
<FONT color="green">814</FONT>        }<a name="line.814"></a>
<FONT color="green">815</FONT>    <a name="line.815"></a>
<FONT color="green">816</FONT>        // Suffix<a name="line.816"></a>
<FONT color="green">817</FONT>        //-----------------------------------------------------------------------<a name="line.817"></a>
<FONT color="green">818</FONT>        /**<a name="line.818"></a>
<FONT color="green">819</FONT>         * Gets the variable suffix matcher currently in use.<a name="line.819"></a>
<FONT color="green">820</FONT>         * &lt;p&gt;<a name="line.820"></a>
<FONT color="green">821</FONT>         * The variable suffix is the characer or characters that identify the<a name="line.821"></a>
<FONT color="green">822</FONT>         * end of a variable. This suffix is expressed in terms of a matcher<a name="line.822"></a>
<FONT color="green">823</FONT>         * allowing advanced suffix matches.<a name="line.823"></a>
<FONT color="green">824</FONT>         *<a name="line.824"></a>
<FONT color="green">825</FONT>         * @return the suffix matcher in use<a name="line.825"></a>
<FONT color="green">826</FONT>         */<a name="line.826"></a>
<FONT color="green">827</FONT>        public StrMatcher getVariableSuffixMatcher() {<a name="line.827"></a>
<FONT color="green">828</FONT>            return suffixMatcher;<a name="line.828"></a>
<FONT color="green">829</FONT>        }<a name="line.829"></a>
<FONT color="green">830</FONT>    <a name="line.830"></a>
<FONT color="green">831</FONT>        /**<a name="line.831"></a>
<FONT color="green">832</FONT>         * Sets the variable suffix matcher currently in use.<a name="line.832"></a>
<FONT color="green">833</FONT>         * &lt;p&gt;<a name="line.833"></a>
<FONT color="green">834</FONT>         * The variable suffix is the characer or characters that identify the<a name="line.834"></a>
<FONT color="green">835</FONT>         * end of a variable. This suffix is expressed in terms of a matcher<a name="line.835"></a>
<FONT color="green">836</FONT>         * allowing advanced suffix matches.<a name="line.836"></a>
<FONT color="green">837</FONT>         *<a name="line.837"></a>
<FONT color="green">838</FONT>         * @param suffixMatcher  the suffix matcher to use, null ignored<a name="line.838"></a>
<FONT color="green">839</FONT>         * @return this, to enable chaining<a name="line.839"></a>
<FONT color="green">840</FONT>         * @throws IllegalArgumentException if the suffix matcher is null<a name="line.840"></a>
<FONT color="green">841</FONT>         */<a name="line.841"></a>
<FONT color="green">842</FONT>        public StrSubstitutor setVariableSuffixMatcher(StrMatcher suffixMatcher) {<a name="line.842"></a>
<FONT color="green">843</FONT>            if (suffixMatcher == null) {<a name="line.843"></a>
<FONT color="green">844</FONT>                throw new IllegalArgumentException("Variable suffix matcher must not be null!");<a name="line.844"></a>
<FONT color="green">845</FONT>            }<a name="line.845"></a>
<FONT color="green">846</FONT>            this.suffixMatcher = suffixMatcher;<a name="line.846"></a>
<FONT color="green">847</FONT>            return this;<a name="line.847"></a>
<FONT color="green">848</FONT>        }<a name="line.848"></a>
<FONT color="green">849</FONT>    <a name="line.849"></a>
<FONT color="green">850</FONT>        /**<a name="line.850"></a>
<FONT color="green">851</FONT>         * Sets the variable suffix to use.<a name="line.851"></a>
<FONT color="green">852</FONT>         * &lt;p&gt;<a name="line.852"></a>
<FONT color="green">853</FONT>         * The variable suffix is the characer or characters that identify the<a name="line.853"></a>
<FONT color="green">854</FONT>         * end of a variable. This method allows a single character suffix to<a name="line.854"></a>
<FONT color="green">855</FONT>         * be easily set.<a name="line.855"></a>
<FONT color="green">856</FONT>         *<a name="line.856"></a>
<FONT color="green">857</FONT>         * @param suffix  the suffix character to use<a name="line.857"></a>
<FONT color="green">858</FONT>         * @return this, to enable chaining<a name="line.858"></a>
<FONT color="green">859</FONT>         */<a name="line.859"></a>
<FONT color="green">860</FONT>        public StrSubstitutor setVariableSuffix(char suffix) {<a name="line.860"></a>
<FONT color="green">861</FONT>            return setVariableSuffixMatcher(StrMatcher.charMatcher(suffix));<a name="line.861"></a>
<FONT color="green">862</FONT>        }<a name="line.862"></a>
<FONT color="green">863</FONT>    <a name="line.863"></a>
<FONT color="green">864</FONT>        /**<a name="line.864"></a>
<FONT color="green">865</FONT>         * Sets the variable suffix to use.<a name="line.865"></a>
<FONT color="green">866</FONT>         * &lt;p&gt;<a name="line.866"></a>
<FONT color="green">867</FONT>         * The variable suffix is the character or characters that identify the<a name="line.867"></a>
<FONT color="green">868</FONT>         * end of a variable. This method allows a string suffix to be easily set.<a name="line.868"></a>
<FONT color="green">869</FONT>         *<a name="line.869"></a>
<FONT color="green">870</FONT>         * @param suffix  the suffix for variables, not null<a name="line.870"></a>
<FONT color="green">871</FONT>         * @return this, to enable chaining<a name="line.871"></a>
<FONT color="green">872</FONT>         * @throws IllegalArgumentException if the suffix is null<a name="line.872"></a>
<FONT color="green">873</FONT>         */<a name="line.873"></a>
<FONT color="green">874</FONT>        public StrSubstitutor setVariableSuffix(String suffix) {<a name="line.874"></a>
<FONT color="green">875</FONT>           if (suffix == null) {<a name="line.875"></a>
<FONT color="green">876</FONT>                throw new IllegalArgumentException("Variable suffix must not be null!");<a name="line.876"></a>
<FONT color="green">877</FONT>            }<a name="line.877"></a>
<FONT color="green">878</FONT>            return setVariableSuffixMatcher(StrMatcher.stringMatcher(suffix));<a name="line.878"></a>
<FONT color="green">879</FONT>        }<a name="line.879"></a>
<FONT color="green">880</FONT>    <a name="line.880"></a>
<FONT color="green">881</FONT>        // Resolver<a name="line.881"></a>
<FONT color="green">882</FONT>        //-----------------------------------------------------------------------<a name="line.882"></a>
<FONT color="green">883</FONT>        /**<a name="line.883"></a>
<FONT color="green">884</FONT>         * Gets the VariableResolver that is used to lookup variables.<a name="line.884"></a>
<FONT color="green">885</FONT>         *<a name="line.885"></a>
<FONT color="green">886</FONT>         * @return the VariableResolver<a name="line.886"></a>
<FONT color="green">887</FONT>         */<a name="line.887"></a>
<FONT color="green">888</FONT>        public StrLookup&lt;?&gt; getVariableResolver() {<a name="line.888"></a>
<FONT color="green">889</FONT>            return this.variableResolver;<a name="line.889"></a>
<FONT color="green">890</FONT>        }<a name="line.890"></a>
<FONT color="green">891</FONT>    <a name="line.891"></a>
<FONT color="green">892</FONT>        /**<a name="line.892"></a>
<FONT color="green">893</FONT>         * Sets the VariableResolver that is used to lookup variables.<a name="line.893"></a>
<FONT color="green">894</FONT>         *<a name="line.894"></a>
<FONT color="green">895</FONT>         * @param variableResolver  the VariableResolver<a name="line.895"></a>
<FONT color="green">896</FONT>         */<a name="line.896"></a>
<FONT color="green">897</FONT>        public void setVariableResolver(StrLookup&lt;?&gt; variableResolver) {<a name="line.897"></a>
<FONT color="green">898</FONT>            this.variableResolver = variableResolver;<a name="line.898"></a>
<FONT color="green">899</FONT>        }<a name="line.899"></a>
<FONT color="green">900</FONT>    <a name="line.900"></a>
<FONT color="green">901</FONT>        // Substitution support in variable names<a name="line.901"></a>
<FONT color="green">902</FONT>        //-----------------------------------------------------------------------<a name="line.902"></a>
<FONT color="green">903</FONT>        /**<a name="line.903"></a>
<FONT color="green">904</FONT>         * Returns a flag whether substitution is done in variable names.<a name="line.904"></a>
<FONT color="green">905</FONT>         *<a name="line.905"></a>
<FONT color="green">906</FONT>         * @return the substitution in variable names flag<a name="line.906"></a>
<FONT color="green">907</FONT>         * @since 3.0<a name="line.907"></a>
<FONT color="green">908</FONT>         */<a name="line.908"></a>
<FONT color="green">909</FONT>        public boolean isEnableSubstitutionInVariables() {<a name="line.909"></a>
<FONT color="green">910</FONT>            return enableSubstitutionInVariables;<a name="line.910"></a>
<FONT color="green">911</FONT>        }<a name="line.911"></a>
<FONT color="green">912</FONT>    <a name="line.912"></a>
<FONT color="green">913</FONT>        /**<a name="line.913"></a>
<FONT color="green">914</FONT>         * Sets a flag whether substitution is done in variable names. If set to<a name="line.914"></a>
<FONT color="green">915</FONT>         * &lt;b&gt;true&lt;/b&gt;, the names of variables can contain other variables which are<a name="line.915"></a>
<FONT color="green">916</FONT>         * processed first before the original variable is evaluated, e.g.<a name="line.916"></a>
<FONT color="green">917</FONT>         * &lt;code&gt;${jre-${java.version}}&lt;/code&gt;. The default value is &lt;b&gt;false&lt;/b&gt;.<a name="line.917"></a>
<FONT color="green">918</FONT>         *<a name="line.918"></a>
<FONT color="green">919</FONT>         * @param enableSubstitutionInVariables the new value of the flag<a name="line.919"></a>
<FONT color="green">920</FONT>         * @since 3.0<a name="line.920"></a>
<FONT color="green">921</FONT>         */<a name="line.921"></a>
<FONT color="green">922</FONT>        public void setEnableSubstitutionInVariables(<a name="line.922"></a>
<FONT color="green">923</FONT>                boolean enableSubstitutionInVariables) {<a name="line.923"></a>
<FONT color="green">924</FONT>            this.enableSubstitutionInVariables = enableSubstitutionInVariables;<a name="line.924"></a>
<FONT color="green">925</FONT>        }<a name="line.925"></a>
<FONT color="green">926</FONT>    }<a name="line.926"></a>




























































</PRE>
</BODY>
</HTML>
